GET students?ssdsIds[0]={ssdsIds[0]}&ssdsIds[1]={ssdsIds[1]}
Get list of students by ssds ids.
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated user who is either StaffMember
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ssdsIds |
SSDS ids. |
Collection of string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of students.
Collection of PearsonEnglish.LearningServices.Core.Models.Views.StudentListItemViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentCode | string |
None. |
|
| CurrentUnit | string |
None. |
|
| ContractStatusLabel | string |
None. |
|
| LatestRiskLevel | PearsonEnglish.LearningServices.Core.Models.Enums.StudentRiskLevel |
None. |
|
| RegistrationType | string |
None. |
|
| RegistrationStatus | string |
None. |
|
| CourseStatus | string |
None. |
|
| UserId | globally unique identifier |
None. |
|
| tempisNewStudent | boolean |
None. |
|
| LastName | string |
None. |
|
| FirstName | string |
None. |
|
| SsdsId | string |
None. |
|
| StudentId | integer |
None. |
|
| PhotoUris | Dictionary of Nse.ServiceBus.DataContracts.ImageResolution [key] and string [value] |
None. |
|
| SocialNetworkAddress1 | string |
None. |
|
| SocialNetworkAddress2 | string |
None. |
|
| SocialNetworkAddress3 | string |
None. |
|
| SocialNetworkAddress4 | string |
None. |
|
| SocialNetwork1 | string |
None. |
|
| SocialNetwork2 | string |
None. |
|
| SocialNetwork3 | string |
None. |
|
| SocialNetwork4 | string |
None. |
|
| string |
None. |
||
| MobileTelephone | string |
None. |
|
| HomeTelephone | string |
None. |
|
| WorkTelephone | string |
None. |
|
| PreferredContactMethod | PearsonEnglish.LearningServices.Core.Models.Enums.StudentPreferredContactMethods |
None. |
|
| PreferredSocialNetworkId | globally unique identifier |
None. |
|
| PreferredSocialNetworkName | string |
None. |
|
| PreferredSocialNetworkAddress | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"StudentCode": "sample string 1",
"CurrentUnit": "sample string 2",
"ContractStatusLabel": "sample string 3",
"LatestRiskLevel": 0,
"RegistrationType": "sample string 4",
"RegistrationStatus": "sample string 5",
"CourseStatus": "sample string 6",
"UserId": "79b4d481-fe08-4901-863d-bec723a50d25",
"tempisNewStudent": true,
"LastName": "sample string 9",
"FirstName": "sample string 10",
"SsdsId": "sample string 11",
"StudentId": 12,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 13",
"SocialNetworkAddress2": "sample string 14",
"SocialNetworkAddress3": "sample string 15",
"SocialNetworkAddress4": "sample string 16",
"SocialNetwork1": "sample string 17",
"SocialNetwork2": "sample string 18",
"SocialNetwork3": "sample string 19",
"SocialNetwork4": "sample string 20",
"Email": "sample string 21",
"MobileTelephone": "sample string 22",
"HomeTelephone": "sample string 23",
"WorkTelephone": "sample string 24",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "984e8e6c-afb7-4824-9124-8b255b250068",
"PreferredSocialNetworkName": "sample string 25",
"PreferredSocialNetworkAddress": "sample string 26"
},
{
"StudentCode": "sample string 1",
"CurrentUnit": "sample string 2",
"ContractStatusLabel": "sample string 3",
"LatestRiskLevel": 0,
"RegistrationType": "sample string 4",
"RegistrationStatus": "sample string 5",
"CourseStatus": "sample string 6",
"UserId": "79b4d481-fe08-4901-863d-bec723a50d25",
"tempisNewStudent": true,
"LastName": "sample string 9",
"FirstName": "sample string 10",
"SsdsId": "sample string 11",
"StudentId": 12,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 13",
"SocialNetworkAddress2": "sample string 14",
"SocialNetworkAddress3": "sample string 15",
"SocialNetworkAddress4": "sample string 16",
"SocialNetwork1": "sample string 17",
"SocialNetwork2": "sample string 18",
"SocialNetwork3": "sample string 19",
"SocialNetwork4": "sample string 20",
"Email": "sample string 21",
"MobileTelephone": "sample string 22",
"HomeTelephone": "sample string 23",
"WorkTelephone": "sample string 24",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "984e8e6c-afb7-4824-9124-8b255b250068",
"PreferredSocialNetworkName": "sample string 25",
"PreferredSocialNetworkAddress": "sample string 26"
}
]